home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / util / rexx / xdmd1.lha / AlphaSpell.man < prev    next >
Text File  |  1993-05-23  |  6KB  |  134 lines
  1. NAME
  2.     AlphaSpell V3.00 - A Command Line Spelling Checker.
  3.  
  4. SYNOPSIS
  5.     AlphaSpell <command> <dictionary>
  6.  
  7.     COMMANDS
  8.         S - Spellcheck, i.e. display unfound stdin words.
  9.         C - Common, i.e. display found stdin words.
  10.         M - Merge the dictionary words w/ the stdin words.
  11.         R - Remove, i.e. display the dictionary words minus the stdin words.
  12.  
  13. COPYRIGHT
  14.     AlphaSpell V3.00 Copyright (C) 1993 Fergus Duniho
  15.  
  16. DESCRIPTION
  17.     AlphaSpell is mainly for spellchecking and dictionary maintenance, and
  18.     it can perform a couple other tasks that were easy to implement and
  19.     might be useful.
  20.  
  21.     SPELLCHECK
  22.         Spellchecking is the main purpose of AlphaSpell. When
  23.         spellchecking, AlphaSpell extracts all the words sent to it though
  24.         standard input, translates them into lowercase, and checks them
  25.         against an alphabetized, lowercase ascii dictionary. It sends to
  26.         standard output any words which it could not find in the
  27.         dictionary. The user should then find these words in the document
  28.         that he had spellchecked and make sure these are the words he wants
  29.         to use. On the Amiga, the user may use an ARexx script I wrote for
  30.         this purpose.
  31.  
  32.     COMMON
  33.         This works like spellchecking, except that AlphaSpell sends to
  34.         standard output every word it did find. This may be useful when you
  35.         want to check for problem words in a document, such as "they're,"
  36.         "their," and "there," or "accept" and "except."
  37.  
  38.     MERGE
  39.         This requires that the file sent through standard input be an
  40.         alphabetized, lowercase ascii dictionary. It is meant for merging
  41.         two ascii dictionaries into one. E.g., you might want to merge your
  42.         user dictionary with your main dictionary.
  43.  
  44.     REMOVE
  45.         Like MERGE, this requires that the file sent through standard input
  46.         be a lowercase ascii dictionary. It sends to standard output all
  47.         the words in the dictionary except those from standard input. This
  48.         is useful for removing unwanted words from the dictionary, such as
  49.         misspellings and jargon you'll never use. Although you could
  50.         probably do this more easily with a text editor if you have enough
  51.         RAM, this feature gives people without enough RAM the same ability.
  52.  
  53.         This feature may also be used for spellchecking alphabetized lists
  54.         of words, as the original AlphaSpell did. When you use it for this
  55.         purpose, you should send the dictionary through standard input and
  56.         give the name of the file you want to spellcheck as the dictionary
  57.         name.
  58.  
  59. DETAILS
  60.  
  61.     WORDS
  62.         A word for AlphaSpell is a string of two or more letters, which may
  63.         have apostrophes inside but not at the ends. Words do not include
  64.         apostrophe-s.
  65.  
  66.         LEGAL WORDS
  67.             ain't
  68.             by
  69.             Amiga
  70.             twas
  71.  
  72.         ILLEGAL WORDS
  73.             a
  74.             'twas
  75.             Amiga's
  76.  
  77.     SPELLCHECKING METHOD
  78.         AlphaSpell spellchecks words in alphabetical order, hence its name.
  79.         As it begins to look for each word, it begins where it left off in
  80.         the dictionary. This allows it to quickly finish spellchecking by
  81.         making only a single pass through the dictionary. It can thereby
  82.         finish spellchecking in less time than it would take to load the
  83.         dictionary into memory.
  84.  
  85. HISTORY
  86.     Before AlphaSpell and before I knew C, I had written a spelling checker
  87.     in ARexx. I don't think I ever released this. But I used a similar
  88.     spellchecking algorithm in AlphaSpell.
  89.  
  90.     I wrote the first version of AlphaSpell in C when I was first trying to
  91.     learn the language back in the Spring of 1992. Its abilities were
  92.     limited because my knowledge of C was limited.
  93.  
  94.     AlphaSpell V2.00 was also in C, but I never released it. It had the
  95.     ability to use a compacted dictionary.
  96.  
  97.     AlphaSpell V3.00 is not a revision of previous versions of AlphaSpell.
  98.     It is a new and better program written from scratch in C++. It is my
  99.     first major C++ program. AlphaSpell uses the same basic algorithm for
  100.     spellchecking, but it implements it with less redundancy.
  101.  
  102.     Previous versions would load in each word from the dictionary and use
  103.     case insensitive comparison. AlphaSpell III spellchecks without loading
  104.     in each word, and it uses case sensitive comparison. Thus, it zips
  105.     through the dictionary faster than previous versions did.
  106.  
  107.     Also, AlphaSpell V3.00 does not depend upon the programs which previous
  108.     versions needed. Previous versions of AlphaSpell needed their input
  109.     prepared by the three programs getwords, sort, and uniq. AlphaSpell
  110.     V3.00 doesn't.
  111.  
  112.     Unlike AlphaSpell V2.00, the unregistered version of AlphaSpell V3.00
  113.     does not work with compacted dictionaries. But the registered version
  114.     does.
  115.  
  116. REGISTRATION
  117.     The registration fee for AlphaSpell V3.00 is $20.00 in United States
  118.     currency or $30.00 in Canadian currency. Only cash and checks are
  119.     accepted. Cash must be American or Canadian, and checks must be drawn
  120.     from an American or Canadian bank. If you live overseas, you might
  121.     arrange a trade with me through email.
  122.  
  123.     ADDED FEATURES OF REGISTERED VERSION
  124.  
  125.         ° A compacted dictionary with close to 100,000 words.
  126.  
  127.         ° The ability to read a compacted dictionary.
  128.  
  129.         ° The ability to compact and decompact ascii dictionaries.
  130.  
  131.         ° Complete C++ source code.
  132.  
  133.  
  134.